Vcenter Lcm Deployment MigrationUpgrade CancellationPolicy

The Vcenter Lcm Deployment MigrationUpgrade CancellationPolicy schema defines the configuration for the upgrade cancellation policy. Some options require specific handling during the upgrade thus they need to be known in advance.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "automatic": false,
    "method": [
        "string"
    ],
    "source_connection": {
        "connection_type": "string"
    }
}

boolean

automatic

Optional

Indicates that the upgrade should be automatically cancelled on error.

This property was added in vSphere API 9.0.0.0.

If missing or null the system will not trigger cancel workflow on error and will wait for additional input.

array of string

method

Optional

Indicates which cancel methods to be used during the upgrade on the source vCenter.

For more information see: Vcenter Lcm Deployment MigrationUpgrade CancelType.

This property was added in vSphere API 9.0.0.0.

If missing or null only the default method is used - Vcenter Lcm Deployment MigrationUpgrade CancelType.CLEAN_UP.

source_connection

Optional

Indicates how to communicate with the source vCenter from the target vCenter if needed.

This property was added in vSphere API 9.0.0.0.

If missing or null the system will only stop the upgrade on the target vCenter but it would not put the source vCenter in operational state, once the POST /vcenter/lcm/deployment/migration-upgrade?action=cancel is called post switchover from source to target vCenter.